com.inscoper.api.Config¶

Config class provides information for global configuration. More...

Public Functions¶

	Name
synchronized void	delete()
	Config() Default constructor.
void	fromXML(XMLNode xml) Provide configuration information from an XML node.
void	toXML(XMLNode xmlParent) Export configuration information in an XML node attached to the parent XML node.
ELogLevel	getAPILogLevel() Get the log level of the API.
void	setAPILogLevel(ELogLevel apiLogLevel) Set the log level of the API.
StringVector	getLibraryPaths() Get the library paths.
void	setLibraryPaths(StringVector libraryPaths) Set the library paths.
StringVector	getDriverList() Get the driver list.
DeviceConfigVector	getDeviceList() Get the device configuration list.
void	setDeviceList(DeviceConfigVector deviceList) Set the device configuration list.
void	addDeviceConfig(DeviceConfig device) Add a device configuration to the list.
String	getConfigPath() Get the configuration path.
void	setConfigPath(String configPath) Set the configuration path.

Protected Functions¶

	Name
	Config(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Config obj)

Detailed Description¶

public class com.inscoper.api.Config;

Config class provides information for global configuration.

This class handles the loading, saving, and management of the global configuration for the Inscoper API, including driver lists, device configurations, and log levels.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function Config¶

public Config()

Default constructor.

Initializes a new instance of the Config class with default values.

function fromXML¶

public void fromXML(
    XMLNode xml
)

Provide configuration information from an XML node.

Parameters:

xml : an XML node containing configuration information

Exceptions:

InscoperException if an error occurred

Loads the configuration settings from the specified XML node.

function toXML¶

public void toXML(
    XMLNode xmlParent
)

Export configuration information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Saves the current configuration settings to the specified parent XML node.

function getAPILogLevel¶

public ELogLevel getAPILogLevel()

Get the log level of the API.

Return: The log level of the API

Retrieves the current logging verbosity level used by the API.

function setAPILogLevel¶

public void setAPILogLevel(
    ELogLevel apiLogLevel
)

Set the log level of the API.

Parameters:

apiLogLevel : The log level of the API

Updates the logging verbosity level for the API.

function getLibraryPaths¶

public StringVector getLibraryPaths()

Get the library paths.

Return: The library paths

Retrieves the list of folders where external libraries (e.g., Micro-Manager, Custom drivers) are located.

function setLibraryPaths¶

public void setLibraryPaths(
    StringVector libraryPaths
)

Set the library paths.

Parameters:

libraryPaths : The list of library paths

Sets the list of folders where external libraries (e.g., Micro-Manager, Custom drivers) are located.

function getDriverList¶

public StringVector getDriverList()

Get the driver list.

Return: The list of drivers

Retrieves the list of available drivers in the configuration.

function getDeviceList¶

public DeviceConfigVector getDeviceList()

Get the device configuration list.

Return: The list of device configurations

Retrieves the list of configured devices.

function setDeviceList¶

public void setDeviceList(
    DeviceConfigVector deviceList
)

Set the device configuration list.

Parameters:

deviceList : The list of device configurations

Updates the list of configured devices.

function addDeviceConfig¶

public void addDeviceConfig(
    DeviceConfig device
)

Add a device configuration to the list.

Parameters:

device : The device configuration to add

Appends a new device configuration to the current list of devices.

function getConfigPath¶

public String getConfigPath()

Get the configuration path.

Return: The path to the current configuration

Retrieves the folder path to the current configuration.

function setConfigPath¶

public void setConfigPath(
    String configPath
)

Set the configuration path.

Parameters:

configPath : The path to the current configuration

Sets the folder path to the current configuration.

Protected Functions Documentation¶

function Config¶

protected Config(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    Config obj
)

Updated on 2026-04-02 at 10:55:37 +0200